///\todo upgrade

//////////////////////////////////////////////////////////////////////////////////
//                                                                              //
//  This file is part of the buola project (https://code.google.com/p/buola/).  //
//                                                                              //
//  Copyright(c) 2007-2012 Xavi Gratal                                          //
//  gratal AT gmail DOT com                                                     //
//                                                                              //
//  Buola is free software: you can redistribute it and/or modify               //
//  it under the terms of the GNU General Public License as published by        //
//  the Free Software Foundation, either version 3 of the License, or           //
//  (at your option) any later version.                                         //
//                                                                              //
//  Buola is distributed in the hope that it will be useful,                    //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of              //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               //
//  GNU General Public License for more details.                                //
//                                                                              //
//  You should have received a copy of the GNU General Public License           //
//  along with buola.  If not, see <http://www.gnu.org/licenses/>.              //
//                                                                              //
//////////////////////////////////////////////////////////////////////////////////

#ifndef __BUOLA_APP_CINITFUNCTION_H__
#define __BUOLA_APP_CINITFUNCTION_H__

#include <buola/buola.h>

namespace buola {

///\addtogroup application
///@{

////////////////////////////////////////////////////////////////////////////

/// function to be called when the program starts

/// When an object of this class is created, it registers a function to
/// be called during application startup
///
/// Objects of this class should never be destroyed, except after the
/// application terminates. They should either be global or static member
/// variables
///
////////////////////////////////////////////////////////////////////////////

class CInitFunction
{
private:
    //! signature for initialization functions
    typedef bool(*tFunction)();

public:
    //! priority levels
    enum EPriority
    {
        PRIORITY_LOWEST,
        PRIORITY_LOWER,
        PRIORITY_LOW,
        PRIORITY_MEDIUM,
        PRIORITY_HIGH,
        PRIORITY_HIGHER,
        PRIORITY_HIGHEST
    };

    //! registers the function
    CInitFunction(tFunction pFunc,const std::wstring &pName,EPriority pPriority=
                                                PRIORITY_MEDIUM);

    //! run all initialization functions
    static bool RunAll();

private:
    //! runs the function itself
    bool Run();

    //! internal management
    static void Reset();
    static CInitFunction *GetSet(CInitFunction* =nullptr);

    //! compare function to sort by priority
    static bool GenericCompare(CInitFunction *p1,CInitFunction *p2);

private:
    tFunction mFunc;
    std::wstring mName;
    bool mDone;
    EPriority mPriority;

    friend class CPlugin;
};

///@}

/*namespace buola*/ }

#endif
